3 * Fetching and processing of interface messages.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @author Niklas Laxström
23 use MediaWiki\MediaWikiServices
;
26 * The Message class provides methods which fulfil two basic services:
27 * - fetching interface messages
28 * - processing messages into a variety of formats
30 * First implemented with MediaWiki 1.17, the Message class is intended to
31 * replace the old wfMsg* functions that over time grew unusable.
32 * @see https://www.mediawiki.org/wiki/Manual:Messages_API for equivalences
33 * between old and new functions.
35 * You should use the wfMessage() global function which acts as a wrapper for
36 * the Message class. The wrapper let you pass parameters as arguments.
38 * The most basic usage cases would be:
41 * // Initialize a Message object using the 'some_key' message key
42 * $message = wfMessage( 'some_key' );
44 * // Using two parameters those values are strings 'value1' and 'value2':
45 * $message = wfMessage( 'some_key',
50 * @section message_global_fn Global function wrapper:
52 * Since wfMessage() returns a Message instance, you can chain its call with
53 * a method. Some of them return a Message instance too so you can chain them.
54 * You will find below several examples of wfMessage() usage.
56 * Fetching a message text for interface message:
59 * $button = Xml::button(
60 * wfMessage( 'submit' )->text()
64 * A Message instance can be passed parameters after it has been constructed,
65 * use the params() method to do so:
68 * wfMessage( 'welcome-to' )
69 * ->params( $wgSitename )
73 * {{GRAMMAR}} and friends work correctly:
76 * wfMessage( 'are-friends',
79 * wfMessage( 'bad-message' )
80 * ->rawParams( '<script>...</script>' )
84 * @section message_language Changing language:
86 * Messages can be requested in a different language or in whatever current
87 * content language is being used. The methods are:
88 * - Message->inContentLanguage()
89 * - Message->inLanguage()
91 * Sometimes the message text ends up in the database, so content language is
95 * wfMessage( 'file-log',
97 * )->inContentLanguage()->text();
100 * Checking whether a message exists:
103 * wfMessage( 'mysterious-message' )->exists()
104 * // returns a boolean whether the 'mysterious-message' key exist.
107 * If you want to use a different language:
110 * $userLanguage = $user->getOption( 'language' );
111 * wfMessage( 'email-header' )
112 * ->inLanguage( $userLanguage )
116 * @note You can parse the text only in the content or interface languages
118 * @section message_compare_old Comparison with old wfMsg* functions:
124 * wfMsgExt( 'key', [ 'parseinline' ], 'apple' );
126 * wfMessage( 'key', 'apple' )->parse();
129 * Parseinline is used because it is more useful when pre-building HTML.
130 * In normal use it is better to use OutputPage::(add|wrap)WikiMsg.
132 * Places where HTML cannot be used. {{-transformation is done.
135 * wfMsgExt( 'key', [ 'parsemag' ], 'apple', 'pear' );
137 * wfMessage( 'key', 'apple', 'pear' )->text();
140 * Shortcut for escaping the message too, similar to wfMsgHTML(), but
141 * parameters are not replaced after escaping by default.
143 * $escaped = wfMessage( 'key' )
144 * ->rawParams( 'apple' )
148 * @section message_appendix Appendix:
151 * - test, can we have tests?
152 * - this documentation needs to be extended
154 * @see https://www.mediawiki.org/wiki/WfMessage()
155 * @see https://www.mediawiki.org/wiki/New_messages_API
156 * @see https://www.mediawiki.org/wiki/Localisation
160 class Message
implements MessageSpecifier
, Serializable
{
161 /** Use message text as-is */
162 const FORMAT_PLAIN
= 'plain';
163 /** Use normal wikitext -> HTML parsing (the result will be wrapped in a block-level HTML tag) */
164 const FORMAT_BLOCK_PARSE
= 'block-parse';
165 /** Use normal wikitext -> HTML parsing but strip the block-level wrapper */
166 const FORMAT_PARSE
= 'parse';
167 /** Transform {{..}} constructs but don't transform to HTML */
168 const FORMAT_TEXT
= 'text';
169 /** Transform {{..}} constructs, HTML-escape the result */
170 const FORMAT_ESCAPED
= 'escaped';
173 * Mapping from Message::listParam() types to Language methods.
176 protected static $listTypeMap = [
177 'comma' => 'commaList',
178 'semicolon' => 'semicolonList',
179 'pipe' => 'pipeList',
180 'text' => 'listToText',
184 * In which language to get this message. True, which is the default,
185 * means the current user language, false content language.
189 protected $interface = true;
192 * In which language to get this message. Overrides the $interface setting.
194 * @var Language|bool Explicit language object, or false for user language
196 protected $language = false;
199 * @var string The message key. If $keysToTry has more than one element,
200 * this may change to one of the keys to try when fetching the message text.
205 * @var string[] List of keys to try when fetching the message.
207 protected $keysToTry;
210 * @var array List of parameters which will be substituted into the message.
212 protected $parameters = [];
218 protected $format = 'parse';
221 * @var bool Whether database can be used.
223 protected $useDatabase = true;
226 * @var Title Title object to use as context.
228 protected $title = null;
231 * @var Content Content object representing the message.
233 protected $content = null;
242 * @param string|string[]|MessageSpecifier $key Message key, or array of
243 * message keys to try and use the first non-empty message for, or a
244 * MessageSpecifier to copy from.
245 * @param array $params Message parameters.
246 * @param Language|null $language [optional] Language to use (defaults to current user language).
247 * @throws InvalidArgumentException
249 public function __construct( $key, $params = [], Language
$language = null ) {
250 if ( $key instanceof MessageSpecifier
) {
252 throw new InvalidArgumentException(
253 '$params must be empty if $key is a MessageSpecifier'
256 $params = $key->getParams();
257 $key = $key->getKey();
260 if ( !is_string( $key ) && !is_array( $key ) ) {
261 throw new InvalidArgumentException( '$key must be a string or an array' );
264 $this->keysToTry
= (array)$key;
266 if ( empty( $this->keysToTry
) ) {
267 throw new InvalidArgumentException( '$key must not be an empty list' );
270 $this->key
= reset( $this->keysToTry
);
272 $this->parameters
= array_values( $params );
273 // User language is only resolved in getLanguage(). This helps preserve the
274 // semantic intent of "user language" across serialize() and unserialize().
275 $this->language
= $language ?
: false;
279 * @see Serializable::serialize()
283 public function serialize() {
285 'interface' => $this->interface,
286 'language' => $this->language ?
$this->language
->getCode() : false,
288 'keysToTry' => $this->keysToTry
,
289 'parameters' => $this->parameters
,
290 'format' => $this->format
,
291 'useDatabase' => $this->useDatabase
,
292 'titlestr' => $this->title ?
$this->title
->getFullText() : null,
297 * @see Serializable::unserialize()
299 * @param string $serialized
301 public function unserialize( $serialized ) {
302 $data = unserialize( $serialized );
303 if ( !is_array( $data ) ) {
304 throw new InvalidArgumentException( __METHOD__
. ': Invalid serialized data' );
307 $this->interface = $data['interface'];
308 $this->key
= $data['key'];
309 $this->keysToTry
= $data['keysToTry'];
310 $this->parameters
= $data['parameters'];
311 $this->format
= $data['format'];
312 $this->useDatabase
= $data['useDatabase'];
313 $this->language
= $data['language'] ? Language
::factory( $data['language'] ) : false;
315 if ( isset( $data['titlestr'] ) ) {
316 $this->title
= Title
::newFromText( $data['titlestr'] );
317 } elseif ( isset( $data['title'] ) && $data['title'] instanceof Title
) {
318 // Old serializations from before December 2018
319 $this->title
= $data['title'];
321 $this->title
= null; // Explicit for sanity
328 * @return bool True if this is a multi-key message, that is, if the key provided to the
329 * constructor was a fallback list of keys to try.
331 public function isMultiKey() {
332 return count( $this->keysToTry
) > 1;
338 * @return string[] The list of keys to try when fetching the message text,
339 * in order of preference.
341 public function getKeysToTry() {
342 return $this->keysToTry
;
346 * Returns the message key.
348 * If a list of multiple possible keys was supplied to the constructor, this method may
349 * return any of these keys. After the message has been fetched, this method will return
350 * the key that was actually used to fetch the message.
356 public function getKey() {
361 * Returns the message parameters.
367 public function getParams() {
368 return $this->parameters
;
372 * Returns the message format.
377 * @deprecated since 1.29 formatting is not stateful
379 public function getFormat() {
380 wfDeprecated( __METHOD__
, '1.29' );
381 return $this->format
;
385 * Returns the Language of the Message.
391 public function getLanguage() {
392 // Defaults to false which means current user language
393 return $this->language ?
: RequestContext
::getMain()->getLanguage();
397 * Factory function that is just wrapper for the real constructor. It is
398 * intended to be used instead of the real constructor, because it allows
399 * chaining method calls, while new objects don't.
403 * @param string|string[]|MessageSpecifier $key
404 * @param mixed $param,... Parameters as strings.
408 public static function newFromKey( $key /*...*/ ) {
409 $params = func_get_args();
410 array_shift( $params );
411 return new self( $key, $params );
415 * Transform a MessageSpecifier or a primitive value used interchangeably with
416 * specifiers (a message key string, or a key + params array) into a proper Message.
418 * Also accepts a MessageSpecifier inside an array: that's not considered a valid format
419 * but is an easy error to make due to how StatusValue stores messages internally.
420 * Further array elements are ignored in that case.
422 * @param string|array|MessageSpecifier $value
424 * @throws InvalidArgumentException
427 public static function newFromSpecifier( $value ) {
429 if ( is_array( $value ) ) {
431 $value = array_shift( $params );
434 if ( $value instanceof Message
) { // Message, RawMessage, ApiMessage, etc
435 $message = clone $value;
436 } elseif ( $value instanceof MessageSpecifier
) {
437 $message = new Message( $value );
438 } elseif ( is_string( $value ) ) {
439 $message = new Message( $value, $params );
441 throw new InvalidArgumentException( __METHOD__
. ': invalid argument type '
442 . gettype( $value ) );
449 * Factory function accepting multiple message keys and returning a message instance
450 * for the first message which is non-empty. If all messages are empty then an
451 * instance of the first message key is returned.
455 * @param string|string[] $keys,... Message keys, or first argument as an array of all the
460 public static function newFallbackSequence( /*...*/ ) {
461 $keys = func_get_args();
462 if ( func_num_args() == 1 ) {
463 if ( is_array( $keys[0] ) ) {
464 // Allow an array to be passed as the first argument instead
465 $keys = array_values( $keys[0] );
467 // Optimize a single string to not need special fallback handling
471 return new self( $keys );
475 * Get a title object for a mediawiki message, where it can be found in the mediawiki namespace.
476 * The title will be for the current language, if the message key is in
477 * $wgForceUIMsgAsContentMsg it will be append with the language code (except content
478 * language), because Message::inContentLanguage will also return in user language.
480 * @see $wgForceUIMsgAsContentMsg
484 public function getTitle() {
485 global $wgForceUIMsgAsContentMsg;
487 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
488 $lang = $this->getLanguage();
491 !$lang->equals( $contLang )
492 && in_array( $this->key
, (array)$wgForceUIMsgAsContentMsg )
494 $title .= '/' . $lang->getCode();
497 return Title
::makeTitle(
498 NS_MEDIAWIKI
, $contLang->ucfirst( strtr( $title, ' ', '_' ) ) );
502 * Adds parameters to the parameter list of this message.
506 * @param mixed $args,... Parameters as strings or arrays from
507 * Message::numParam() and the like, or a single array of parameters.
509 * @return Message $this
511 public function params( /*...*/ ) {
512 $args = func_get_args();
514 // If $args has only one entry and it's an array, then it's either a
515 // non-varargs call or it happens to be a call with just a single
516 // "special" parameter. Since the "special" parameters don't have any
517 // numeric keys, we'll test that to differentiate the cases.
518 if ( count( $args ) === 1 && isset( $args[0] ) && is_array( $args[0] ) ) {
519 if ( $args[0] === [] ) {
522 foreach ( $args[0] as $key => $value ) {
523 if ( is_int( $key ) ) {
531 $this->parameters
= array_merge( $this->parameters
, array_values( $args ) );
536 * Add parameters that are substituted after parsing or escaping.
537 * In other words the parsing process cannot access the contents
538 * of this type of parameter, and you need to make sure it is
539 * sanitized beforehand. The parser will see "$n", instead.
543 * @param mixed $params,... Raw parameters as strings, or a single argument that is
544 * an array of raw parameters.
546 * @return Message $this
548 public function rawParams( /*...*/ ) {
549 $params = func_get_args();
550 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
551 $params = $params[0];
553 foreach ( $params as $param ) {
554 $this->parameters
[] = self
::rawParam( $param );
560 * Add parameters that are numeric and will be passed through
561 * Language::formatNum before substitution
565 * @param mixed $param,... Numeric parameters, or a single argument that is
566 * an array of numeric parameters.
568 * @return Message $this
570 public function numParams( /*...*/ ) {
571 $params = func_get_args();
572 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
573 $params = $params[0];
575 foreach ( $params as $param ) {
576 $this->parameters
[] = self
::numParam( $param );
582 * Add parameters that are durations of time and will be passed through
583 * Language::formatDuration before substitution
587 * @param int|int[] $param,... Duration parameters, or a single argument that is
588 * an array of duration parameters.
590 * @return Message $this
592 public function durationParams( /*...*/ ) {
593 $params = func_get_args();
594 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
595 $params = $params[0];
597 foreach ( $params as $param ) {
598 $this->parameters
[] = self
::durationParam( $param );
604 * Add parameters that are expiration times and will be passed through
605 * Language::formatExpiry before substitution
609 * @param string|string[] $param,... Expiry parameters, or a single argument that is
610 * an array of expiry parameters.
612 * @return Message $this
614 public function expiryParams( /*...*/ ) {
615 $params = func_get_args();
616 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
617 $params = $params[0];
619 foreach ( $params as $param ) {
620 $this->parameters
[] = self
::expiryParam( $param );
626 * Add parameters that are time periods and will be passed through
627 * Language::formatTimePeriod before substitution
631 * @param int|int[] $param,... Time period parameters, or a single argument that is
632 * an array of time period parameters.
634 * @return Message $this
636 public function timeperiodParams( /*...*/ ) {
637 $params = func_get_args();
638 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
639 $params = $params[0];
641 foreach ( $params as $param ) {
642 $this->parameters
[] = self
::timeperiodParam( $param );
648 * Add parameters that are file sizes and will be passed through
649 * Language::formatSize before substitution
653 * @param int|int[] $param,... Size parameters, or a single argument that is
654 * an array of size parameters.
656 * @return Message $this
658 public function sizeParams( /*...*/ ) {
659 $params = func_get_args();
660 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
661 $params = $params[0];
663 foreach ( $params as $param ) {
664 $this->parameters
[] = self
::sizeParam( $param );
670 * Add parameters that are bitrates and will be passed through
671 * Language::formatBitrate before substitution
675 * @param int|int[] $param,... Bit rate parameters, or a single argument that is
676 * an array of bit rate parameters.
678 * @return Message $this
680 public function bitrateParams( /*...*/ ) {
681 $params = func_get_args();
682 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
683 $params = $params[0];
685 foreach ( $params as $param ) {
686 $this->parameters
[] = self
::bitrateParam( $param );
692 * Add parameters that are plaintext and will be passed through without
693 * the content being evaluated. Plaintext parameters are not valid as
694 * arguments to parser functions. This differs from self::rawParams in
695 * that the Message class handles escaping to match the output format.
699 * @param string|string[] $param,... plaintext parameters, or a single argument that is
700 * an array of plaintext parameters.
702 * @return Message $this
704 public function plaintextParams( /*...*/ ) {
705 $params = func_get_args();
706 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
707 $params = $params[0];
709 foreach ( $params as $param ) {
710 $this->parameters
[] = self
::plaintextParam( $param );
716 * Set the language and the title from a context object
720 * @param IContextSource $context
722 * @return Message $this
724 public function setContext( IContextSource
$context ) {
725 $this->inLanguage( $context->getLanguage() );
726 $this->title( $context->getTitle() );
727 $this->interface = true;
733 * Request the message in any language that is supported.
735 * As a side effect interface message status is unconditionally
739 * @param Language|string $lang Language code or Language object.
740 * @return Message $this
741 * @throws MWException
743 public function inLanguage( $lang ) {
744 $previousLanguage = $this->language
;
746 if ( $lang instanceof Language
) {
747 $this->language
= $lang;
748 } elseif ( is_string( $lang ) ) {
749 if ( !$this->language
instanceof Language ||
$this->language
->getCode() != $lang ) {
750 $this->language
= Language
::factory( $lang );
752 } elseif ( $lang instanceof StubUserLang
) {
753 $this->language
= false;
755 $type = gettype( $lang );
756 throw new MWException( __METHOD__
. " must be "
757 . "passed a String or Language object; $type given"
761 if ( $this->language
!== $previousLanguage ) {
762 // The language has changed. Clear the message cache.
763 $this->message
= null;
765 $this->interface = false;
770 * Request the message in the wiki's content language,
771 * unless it is disabled for this message.
774 * @see $wgForceUIMsgAsContentMsg
776 * @return Message $this
778 public function inContentLanguage() {
779 global $wgForceUIMsgAsContentMsg;
780 if ( in_array( $this->key
, (array)$wgForceUIMsgAsContentMsg ) ) {
784 $this->inLanguage( MediaWikiServices
::getInstance()->getContentLanguage() );
789 * Allows manipulating the interface message flag directly.
790 * Can be used to restore the flag after setting a language.
794 * @param bool $interface
796 * @return Message $this
798 public function setInterfaceMessageFlag( $interface ) {
799 $this->interface = (bool)$interface;
804 * Enable or disable database use.
808 * @param bool $useDatabase
810 * @return Message $this
812 public function useDatabase( $useDatabase ) {
813 $this->useDatabase
= (bool)$useDatabase;
814 $this->message
= null;
819 * Set the Title object to use as context when transforming the message
823 * @param Title $title
825 * @return Message $this
827 public function title( $title ) {
828 $this->title
= $title;
833 * Returns the message as a Content object.
837 public function content() {
838 if ( !$this->content
) {
839 $this->content
= new MessageContent( $this );
842 return $this->content
;
846 * Returns the message parsed from wikitext to HTML.
850 * @param string|null $format One of the FORMAT_* constants. Null means use whatever was used
851 * the last time (this is for B/C and should be avoided).
853 * @return string HTML
854 * @suppress SecurityCheck-DoubleEscaped phan false positive
856 public function toString( $format = null ) {
857 if ( $format === null ) {
858 $ex = new LogicException( __METHOD__
. ' using implicit format: ' . $this->format
);
859 \MediaWiki\Logger\LoggerFactory
::getInstance( 'message-format' )->warning(
860 $ex->getMessage(), [ 'exception' => $ex, 'format' => $this->format
, 'key' => $this->key
] );
861 $format = $this->format
;
863 $string = $this->fetchMessage();
865 if ( $string === false ) {
866 // Err on the side of safety, ensure that the output
867 // is always html safe in the event the message key is
868 // missing, since in that case its highly likely the
869 // message key is user-controlled.
870 // '⧼' is used instead of '<' to side-step any
871 // double-escaping issues.
872 // (Keep synchronised with mw.Message#toString in JS.)
873 return '⧼' . htmlspecialchars( $this->key
) . '⧽';
876 # Replace $* with a list of parameters for &uselang=qqx.
877 if ( strpos( $string, '$*' ) !== false ) {
879 if ( $this->parameters
!== [] ) {
880 $paramlist = ': $' . implode( ', $', range( 1, count( $this->parameters
) ) );
882 $string = str_replace( '$*', $paramlist, $string );
885 # Replace parameters before text parsing
886 $string = $this->replaceParameters( $string, 'before', $format );
888 # Maybe transform using the full parser
889 if ( $format === self
::FORMAT_PARSE
) {
890 $string = $this->parseText( $string );
891 $string = Parser
::stripOuterParagraph( $string );
892 } elseif ( $format === self
::FORMAT_BLOCK_PARSE
) {
893 $string = $this->parseText( $string );
894 } elseif ( $format === self
::FORMAT_TEXT
) {
895 $string = $this->transformText( $string );
896 } elseif ( $format === self
::FORMAT_ESCAPED
) {
897 $string = $this->transformText( $string );
898 $string = htmlspecialchars( $string, ENT_QUOTES
, 'UTF-8', false );
901 # Raw parameter replacement
902 $string = $this->replaceParameters( $string, 'after', $format );
908 * Magic method implementation of the above (for PHP >= 5.2.0), so we can do, eg:
909 * $foo = new Message( $key );
910 * $string = "<abbr>$foo</abbr>";
916 public function __toString() {
917 // PHP doesn't allow __toString to throw exceptions and will
918 // trigger a fatal error if it does. So, catch any exceptions.
921 return $this->toString( self
::FORMAT_PARSE
);
922 } catch ( Exception
$ex ) {
924 trigger_error( "Exception caught in " . __METHOD__
. " (message " . $this->key
. "): "
925 . $ex, E_USER_WARNING
);
926 } catch ( Exception
$ex ) {
927 // Doh! Cause a fatal error after all?
930 return '⧼' . htmlspecialchars( $this->key
) . '⧽';
935 * Fully parse the text from wikitext to HTML.
939 * @return string Parsed HTML.
941 public function parse() {
942 $this->format
= self
::FORMAT_PARSE
;
943 return $this->toString( self
::FORMAT_PARSE
);
947 * Returns the message text. {{-transformation is done.
951 * @return string Unescaped message text.
953 public function text() {
954 $this->format
= self
::FORMAT_TEXT
;
955 return $this->toString( self
::FORMAT_TEXT
);
959 * Returns the message text as-is, only parameters are substituted.
963 * @return string Unescaped untransformed message text.
965 public function plain() {
966 $this->format
= self
::FORMAT_PLAIN
;
967 return $this->toString( self
::FORMAT_PLAIN
);
971 * Returns the parsed message text which is always surrounded by a block element.
975 * @return string HTML
977 public function parseAsBlock() {
978 $this->format
= self
::FORMAT_BLOCK_PARSE
;
979 return $this->toString( self
::FORMAT_BLOCK_PARSE
);
983 * Returns the message text. {{-transformation is done and the result
984 * is escaped excluding any raw parameters.
988 * @return string Escaped message text.
990 public function escaped() {
991 $this->format
= self
::FORMAT_ESCAPED
;
992 return $this->toString( self
::FORMAT_ESCAPED
);
996 * Check whether a message key has been defined currently.
1002 public function exists() {
1003 return $this->fetchMessage() !== false;
1007 * Check whether a message does not exist, or is an empty string
1010 * @todo FIXME: Merge with isDisabled()?
1014 public function isBlank() {
1015 $message = $this->fetchMessage();
1016 return $message === false ||
$message === '';
1020 * Check whether a message does not exist, is an empty string, or is "-".
1026 public function isDisabled() {
1027 $message = $this->fetchMessage();
1028 return $message === false ||
$message === '' ||
$message === '-';
1036 * @return array Array with a single "raw" key.
1038 public static function rawParam( $raw ) {
1039 return [ 'raw' => $raw ];
1047 * @return array Array with a single "num" key.
1049 public static function numParam( $num ) {
1050 return [ 'num' => $num ];
1056 * @param int $duration
1058 * @return int[] Array with a single "duration" key.
1060 public static function durationParam( $duration ) {
1061 return [ 'duration' => $duration ];
1067 * @param string $expiry
1069 * @return string[] Array with a single "expiry" key.
1071 public static function expiryParam( $expiry ) {
1072 return [ 'expiry' => $expiry ];
1078 * @param int $period
1080 * @return int[] Array with a single "period" key.
1082 public static function timeperiodParam( $period ) {
1083 return [ 'period' => $period ];
1091 * @return int[] Array with a single "size" key.
1093 public static function sizeParam( $size ) {
1094 return [ 'size' => $size ];
1100 * @param int $bitrate
1102 * @return int[] Array with a single "bitrate" key.
1104 public static function bitrateParam( $bitrate ) {
1105 return [ 'bitrate' => $bitrate ];
1111 * @param string $plaintext
1113 * @return string[] Array with a single "plaintext" key.
1115 public static function plaintextParam( $plaintext ) {
1116 return [ 'plaintext' => $plaintext ];
1122 * @param array $list
1123 * @param string $type 'comma', 'semicolon', 'pipe', 'text'
1124 * @return array Array with "list" and "type" keys.
1126 public static function listParam( array $list, $type = 'text' ) {
1127 if ( !isset( self
::$listTypeMap[$type] ) ) {
1128 throw new InvalidArgumentException(
1129 "Invalid type '$type'. Known types are: " . implode( ', ', array_keys( self
::$listTypeMap ) )
1132 return [ 'list' => $list, 'type' => $type ];
1136 * Substitutes any parameters into the message text.
1140 * @param string $message The message text.
1141 * @param string $type Either "before" or "after".
1142 * @param string $format One of the FORMAT_* constants.
1146 protected function replaceParameters( $message, $type, $format ) {
1147 // A temporary marker for $1 parameters that is only valid
1148 // in non-attribute contexts. However if the entire message is escaped
1149 // then we don't want to use it because it will be mangled in all contexts
1150 // and its unnessary as ->escaped() messages aren't html.
1151 $marker = $format === self
::FORMAT_ESCAPED ?
'$' : '$\'"';
1152 $replacementKeys = [];
1153 foreach ( $this->parameters
as $n => $param ) {
1154 list( $paramType, $value ) = $this->extractParam( $param, $format );
1155 if ( $type === 'before' ) {
1156 if ( $paramType === 'before' ) {
1157 $replacementKeys['$' . ( $n +
1 )] = $value;
1158 } else /* $paramType === 'after' */ {
1159 // To protect against XSS from replacing parameters
1160 // inside html attributes, we convert $1 to $'"1.
1161 // In the event that one of the parameters ends up
1162 // in an attribute, either the ' or the " will be
1163 // escaped, breaking the replacement and avoiding XSS.
1164 $replacementKeys['$' . ( $n +
1 )] = $marker . ( $n +
1 );
1167 if ( $paramType === 'after' ) {
1168 $replacementKeys[$marker . ( $n +
1 )] = $value;
1172 $message = strtr( $message, $replacementKeys );
1177 * Extracts the parameter type and preprocessed the value if needed.
1181 * @param mixed $param Parameter as defined in this class.
1182 * @param string $format One of the FORMAT_* constants.
1184 * @return array Array with the parameter type (either "before" or "after") and the value.
1186 protected function extractParam( $param, $format ) {
1187 if ( is_array( $param ) ) {
1188 if ( isset( $param['raw'] ) ) {
1189 return [ 'after', $param['raw'] ];
1190 } elseif ( isset( $param['num'] ) ) {
1191 // Replace number params always in before step for now.
1192 // No support for combined raw and num params
1193 return [ 'before', $this->getLanguage()->formatNum( $param['num'] ) ];
1194 } elseif ( isset( $param['duration'] ) ) {
1195 return [ 'before', $this->getLanguage()->formatDuration( $param['duration'] ) ];
1196 } elseif ( isset( $param['expiry'] ) ) {
1197 return [ 'before', $this->getLanguage()->formatExpiry( $param['expiry'] ) ];
1198 } elseif ( isset( $param['period'] ) ) {
1199 return [ 'before', $this->getLanguage()->formatTimePeriod( $param['period'] ) ];
1200 } elseif ( isset( $param['size'] ) ) {
1201 return [ 'before', $this->getLanguage()->formatSize( $param['size'] ) ];
1202 } elseif ( isset( $param['bitrate'] ) ) {
1203 return [ 'before', $this->getLanguage()->formatBitrate( $param['bitrate'] ) ];
1204 } elseif ( isset( $param['plaintext'] ) ) {
1205 return [ 'after', $this->formatPlaintext( $param['plaintext'], $format ) ];
1206 } elseif ( isset( $param['list'] ) ) {
1207 return $this->formatListParam( $param['list'], $param['type'], $format );
1209 if ( !is_scalar( $param ) ) {
1210 $param = serialize( $param );
1212 \MediaWiki\Logger\LoggerFactory
::getInstance( 'Bug58676' )->warning(
1213 'Invalid parameter for message "{msgkey}": {param}',
1215 'exception' => new Exception
,
1216 'msgkey' => $this->getKey(),
1217 'param' => htmlspecialchars( $param ),
1221 return [ 'before', '[INVALID]' ];
1223 } elseif ( $param instanceof Message
) {
1224 // Match language, flags, etc. to the current message.
1225 $msg = clone $param;
1226 if ( $msg->language
!== $this->language ||
$msg->useDatabase
!== $this->useDatabase
) {
1227 // Cache depends on these parameters
1228 $msg->message
= null;
1230 $msg->interface = $this->interface;
1231 $msg->language
= $this->language
;
1232 $msg->useDatabase
= $this->useDatabase
;
1233 $msg->title
= $this->title
;
1236 if ( $format === 'block-parse' ) {
1239 $msg->format
= $format;
1241 // Message objects should not be before parameters because
1242 // then they'll get double escaped. If the message needs to be
1243 // escaped, it'll happen right here when we call toString().
1244 return [ 'after', $msg->toString( $format ) ];
1246 return [ 'before', $param ];
1251 * Wrapper for what ever method we use to parse wikitext.
1255 * @param string $string Wikitext message contents.
1257 * @return string Wikitext parsed into HTML.
1259 protected function parseText( $string ) {
1260 $out = MessageCache
::singleton()->parse(
1265 $this->getLanguage()
1268 return $out instanceof ParserOutput
1270 'enableSectionEditLinks' => false,
1271 // Wrapping messages in an extra <div> is probably not expected. If
1272 // they're outside the content area they probably shouldn't be
1273 // targeted by CSS that's targeting the parser output, and if
1274 // they're inside they already are from the outer div.
1281 * Wrapper for what ever method we use to {{-transform wikitext.
1285 * @param string $string Wikitext message contents.
1287 * @return string Wikitext with {{-constructs replaced with their values.
1289 protected function transformText( $string ) {
1290 return MessageCache
::singleton()->transform(
1293 $this->getLanguage(),
1299 * Wrapper for what ever method we use to get message contents.
1304 * @throws MWException If message key array is empty.
1306 protected function fetchMessage() {
1307 if ( $this->message
=== null ) {
1308 $cache = MessageCache
::singleton();
1310 foreach ( $this->keysToTry
as $key ) {
1311 $message = $cache->get( $key, $this->useDatabase
, $this->getLanguage() );
1312 if ( $message !== false && $message !== '' ) {
1317 // NOTE: The constructor makes sure keysToTry isn't empty,
1318 // so we know that $key and $message are initialized.
1320 $this->message
= $message;
1322 return $this->message
;
1326 * Formats a message parameter wrapped with 'plaintext'. Ensures that
1327 * the entire string is displayed unchanged when displayed in the output
1332 * @param string $plaintext String to ensure plaintext output of
1333 * @param string $format One of the FORMAT_* constants.
1335 * @return string Input plaintext encoded for output to $format
1337 protected function formatPlaintext( $plaintext, $format ) {
1338 switch ( $format ) {
1339 case self
::FORMAT_TEXT
:
1340 case self
::FORMAT_PLAIN
:
1343 case self
::FORMAT_PARSE
:
1344 case self
::FORMAT_BLOCK_PARSE
:
1345 case self
::FORMAT_ESCAPED
:
1347 return htmlspecialchars( $plaintext, ENT_QUOTES
);
1352 * Formats a list of parameters as a concatenated string.
1354 * @param array $params
1355 * @param string $listType
1356 * @param string $format One of the FORMAT_* constants.
1357 * @return array Array with the parameter type (either "before" or "after") and the value.
1359 protected function formatListParam( array $params, $listType, $format ) {
1360 if ( !isset( self
::$listTypeMap[$listType] ) ) {
1361 $warning = 'Invalid list type for message "' . $this->getKey() . '": '
1362 . htmlspecialchars( $listType )
1363 . ' (params are ' . htmlspecialchars( serialize( $params ) ) . ')';
1364 trigger_error( $warning, E_USER_WARNING
);
1366 wfDebugLog( 'Bug58676', $warning . "\n" . $e->getTraceAsString() );
1367 return [ 'before', '[INVALID]' ];
1369 $func = self
::$listTypeMap[$listType];
1371 // Handle an empty list sensibly
1373 return [ 'before', $this->getLanguage()->$func( [] ) ];
1376 // First, determine what kinds of list items we have
1380 foreach ( $params as $n => $p ) {
1381 list( $type, $value ) = $this->extractParam( $p, $format );
1382 $types[$type] = true;
1384 $vars[] = '$' . ( $n +
1 );
1387 // Easy case: all are 'before' or 'after', so just join the
1388 // values and use the same type.
1389 if ( count( $types ) === 1 ) {
1390 return [ key( $types ), $this->getLanguage()->$func( $list ) ];
1393 // Hard case: We need to process each value per its type, then
1394 // return the concatenated values as 'after'. We handle this by turning
1395 // the list into a RawMessage and processing that as a parameter.
1396 $vars = $this->getLanguage()->$func( $vars );
1397 return $this->extractParam( new RawMessage( $vars, $params ), $format );